home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1995 August: Tool Chest / Dev.CD Aug 95 TC / Dev.CD Aug 95 TC.toast / Tool Chest / Interfaces / UniversalInterfaces 2.0 / PInterfaces / DatabaseAccess.p < prev    next >
Encoding:
Text File  |  1995-04-18  |  10.8 KB  |  327 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        DatabaseAccess.p
  3.  
  4.      Contains:    Database Access Manager Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Package:    Universal Interfaces 2.0 in “MPW Latest” on ETO #17
  8.  
  9.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  10.                  All rights reserved.
  11.  
  12.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13.                  stack.  Include the file and version information (from above)
  14.                  in the problem description and send to:
  15.                      Internet:    apple.bugs@applelink.apple.com
  16.                      AppleLink:    APPLE.BUGS
  17.  
  18. }
  19.  
  20. {$IFC UNDEFINED UsingIncludes}
  21. {$SETC UsingIncludes := 0}
  22. {$ENDC}
  23.  
  24. {$IFC NOT UsingIncludes}
  25.  UNIT DatabaseAccess;
  26.  INTERFACE
  27. {$ENDC}
  28.  
  29. {$IFC UNDEFINED __DATABASEACCESS__}
  30. {$SETC __DATABASEACCESS__ := 1}
  31.  
  32. {$I+}
  33. {$SETC DatabaseAccessIncludes := UsingIncludes}
  34. {$SETC UsingIncludes := 1}
  35.  
  36.  
  37. {$IFC UNDEFINED __RESOURCES__}
  38. {$I Resources.p}
  39. {$ENDC}
  40. {    Types.p                                                        }
  41. {        ConditionalMacros.p                                        }
  42. {    MixedMode.p                                                    }
  43. {    Files.p                                                        }
  44. {        OSUtils.p                                                }
  45. {            Memory.p                                            }
  46.  
  47. {$PUSH}
  48. {$ALIGN MAC68K}
  49. {$LibExport+}
  50.  
  51. CONST
  52.     typeNone                    = 'none';
  53.     typeDate                    = 'date';
  54.     typeTime                    = 'time';
  55.     typeTimeStamp                = 'tims';
  56.     typeDecimal                    = 'deci';
  57.     typeMoney                    = 'mone';
  58.     typeVChar                    = 'vcha';
  59.     typeVBin                    = 'vbin';
  60.     typeLChar                    = 'lcha';
  61.     typeLBin                    = 'lbin';
  62.     typeDiscard                    = 'disc';
  63. { "dummy" types for DBResultsToText }
  64.     typeUnknown                    = 'unkn';
  65.     typeColBreak                = 'colb';
  66.     typeRowBreak                = 'rowb';
  67. { pass this in to DBGetItem for any data type }
  68.     typeAnyType                    = 0;
  69.  
  70. { infinite timeout value for DBGetItem }
  71. { messages for status functions for DBStartQuery }
  72.     kDBUpdateWind                = 0;
  73.     kDBAboutToInit                = 1;
  74.     kDBInitComplete                = 2;
  75.     kDBSendComplete                = 3;
  76.     kDBExecComplete                = 4;
  77.     kDBStartQueryComplete        = 5;
  78.  
  79. { messages for status functions for DBGetQueryResults }
  80.     kDBGetItemComplete            = 6;
  81.     kDBGetQueryResultsComplete    = 7;
  82.     kDBWaitForever                = -1;
  83. {  flags for DBGetItem  }
  84.     kDBLastColFlag                = $0001;
  85.     kDBNullFlag                    = $0004;
  86.  
  87.     
  88. TYPE
  89.     DBType = OSType;
  90.  
  91.     DBAsyncParmBlkPtr = ^DBAsyncParamBlockRec;
  92.  
  93.     {
  94.         DBCompletionProcPtr uses register based parameters on the 68k and cannot
  95.         be written in or called from a high-level language without the help of
  96.         mixed mode or assembly glue.
  97.  
  98.         In:
  99.          => pb              A1.L
  100.     }
  101.     DBCompletionProcPtr = Register68kProcPtr;  { register PROCEDURE DBCompletion(pb: DBAsyncParmBlkPtr); }
  102.     DBCompletionUPP = UniversalProcPtr;
  103.  
  104.     DBAsyncParamBlockRec = RECORD
  105.         completionProc:            DBCompletionUPP;                        { pointer to completion routine }
  106.         result:                    OSErr;                                    { result of call }
  107.         userRef:                LONGINT;                                { for application's use }
  108.         ddevRef:                LONGINT;                                { for ddev's use }
  109.         reserved:                LONGINT;                                { for internal use }
  110.     END;
  111.  
  112. CONST
  113.     uppDBCompletionProcInfo = $0000B802; { Register PROCEDURE (4 bytes in A1); }
  114.  
  115. PROCEDURE CallDBCompletionProc(pb: DBAsyncParmBlkPtr; userRoutine: DBCompletionUPP);
  116.     {$IFC NOT GENERATINGCFM}
  117.     {To be implemented:  Glue to move parameters into registers.}
  118.     {$ENDC}
  119.  
  120. FUNCTION NewDBCompletionProc(userRoutine: DBCompletionProcPtr): DBCompletionUPP;
  121.     {$IFC NOT GENERATINGCFM }
  122.     INLINE $2E9F;
  123.     {$ENDC}
  124.  
  125. TYPE
  126.     ResListElem = RECORD
  127.         theType:                ResType;                                { resource type }
  128.         id:                        INTEGER;                                { resource id }
  129.     END;
  130.  
  131.     ResListPtr = ^ResListElem;
  132.     ResListHandle = ^ResListPtr;
  133.  
  134. { structure for query list in QueryRecord }
  135.     QueryArray = ARRAY [0..255] OF Handle;
  136.  
  137.     QueryListPtr = ^QueryArray;
  138.     QueryListHandle = ^QueryListPtr;
  139.  
  140.     QueryRecord = RECORD
  141.         version:                INTEGER;                                { version }
  142.         id:                        INTEGER;                                { id of 'qrsc' this came from }
  143.         queryProc:                Handle;                                    { handle to query def proc }
  144.         ddevName:                Str63;                                    { ddev name }
  145.         host:                    Str255;                                    { host name }
  146.         user:                    Str255;                                    { user name }
  147.         password:                Str255;                                    { password }
  148.         connStr:                Str255;                                    { connection string }
  149.         currQuery:                INTEGER;                                { index of current query }
  150.         numQueries:                INTEGER;                                { number of queries in list }
  151.         queryList:                QueryListHandle;                        { handle to array of handles to text }
  152.         numRes:                    INTEGER;                                { number of resources in list }
  153.         resList:                ResListHandle;                            { handle to array of resource list elements }
  154.         dataHandle:                Handle;                                    { for use by query def proc }
  155.         refCon:                    LONGINT;                                { for use by application }
  156.     END;
  157.  
  158.     QueryPtr = ^QueryRecord;
  159.     QueryHandle = ^QueryPtr;
  160.  
  161. { structure of column types array in ResultsRecord }
  162.     ColTypesArray = ARRAY [0..255] OF DBType;
  163.  
  164.     ColTypesPtr = ^ColTypesArray;
  165.     ColTypesHandle = ^ColTypesPtr;
  166.  
  167.     DBColInfoRecord = RECORD
  168.         len:                    INTEGER;
  169.         places:                    INTEGER;
  170.         flags:                    INTEGER;
  171.     END;
  172.  
  173.     ColInfoArray = ARRAY [0..255] OF DBColInfoRecord;
  174.  
  175.     ColInfoPtr = ^ColInfoArray;
  176.     ColInfoHandle = ^ColInfoPtr;
  177.  
  178.     ResultsRecord = RECORD
  179.         numRows:                INTEGER;                                { number of rows in result }
  180.         numCols:                INTEGER;                                { number of columns per row }
  181.         colTypes:                ColTypesHandle;                            { data type array }
  182.         colData:                Handle;                                    { actual results }
  183.         colInfo:                ColInfoHandle;                            { DBColInfoRecord array }
  184.     END;
  185.  
  186.     DBQueryDefProcPtr = ProcPtr;  { FUNCTION DBQueryDef(VAR sessID: LONGINT; query: QueryHandle): OSErr; }
  187.     DBStatusProcPtr = ProcPtr;  { FUNCTION DBStatus(message: INTEGER; result: OSErr; dataLen: INTEGER; dataPlaces: INTEGER; dataFlags: INTEGER; dataType: DBType; dataPtr: Ptr): BOOLEAN; }
  188.     DBResultHandlerProcPtr = ProcPtr;  { FUNCTION DBResultHandler(dataType: DBType; theLen: INTEGER; thePlaces: INTEGER; theFlags: INTEGER; theData: Ptr; theText: Handle): OSErr; }
  189.     DBQueryDefUPP = UniversalProcPtr;
  190.     DBStatusUPP = UniversalProcPtr;
  191.     DBResultHandlerUPP = UniversalProcPtr;
  192.  
  193. CONST
  194.     uppDBQueryDefProcInfo = $000003E0; { FUNCTION (4 byte param, 4 byte param): 2 byte result; }
  195.     uppDBStatusProcInfo = $000FAA90; { FUNCTION (2 byte param, 2 byte param, 2 byte param, 2 byte param, 2 byte param, 4 byte param, 4 byte param): 1 byte result; }
  196.     uppDBResultHandlerProcInfo = $0003EAE0; { FUNCTION (4 byte param, 2 byte param, 2 byte param, 2 byte param, 4 byte param, 4 byte param): 2 byte result; }
  197.  
  198. FUNCTION NewDBQueryDefProc(userRoutine: DBQueryDefProcPtr): DBQueryDefUPP;
  199.     {$IFC NOT GENERATINGCFM }
  200.     INLINE $2E9F;
  201.     {$ENDC}
  202.  
  203. FUNCTION NewDBStatusProc(userRoutine: DBStatusProcPtr): DBStatusUPP;
  204.     {$IFC NOT GENERATINGCFM }
  205.     INLINE $2E9F;
  206.     {$ENDC}
  207.  
  208. FUNCTION NewDBResultHandlerProc(userRoutine: DBResultHandlerProcPtr): DBResultHandlerUPP;
  209.     {$IFC NOT GENERATINGCFM }
  210.     INLINE $2E9F;
  211.     {$ENDC}
  212.  
  213. FUNCTION CallDBQueryDefProc(VAR sessID: LONGINT; query: QueryHandle; userRoutine: DBQueryDefUPP): OSErr;
  214.     {$IFC NOT GENERATINGCFM}
  215.     INLINE $205F, $4E90;
  216.     {$ENDC}
  217.  
  218. FUNCTION CallDBStatusProc(message: INTEGER; result: OSErr; dataLen: INTEGER; dataPlaces: INTEGER; dataFlags: INTEGER; dataType: DBType; dataPtr: Ptr; userRoutine: DBStatusUPP): BOOLEAN;
  219.     {$IFC NOT GENERATINGCFM}
  220.     INLINE $205F, $4E90;
  221.     {$ENDC}
  222.  
  223. FUNCTION CallDBResultHandlerProc(dataType: DBType; theLen: INTEGER; thePlaces: INTEGER; theFlags: INTEGER; theData: Ptr; theText: Handle; userRoutine: DBResultHandlerUPP): OSErr;
  224.     {$IFC NOT GENERATINGCFM}
  225.     INLINE $205F, $4E90;
  226.     {$ENDC}
  227.  
  228. FUNCTION InitDBPack: OSErr;
  229.     {$IFC NOT GENERATINGCFM}
  230.     INLINE $3F3C, $0004, $303C, $0100, $A82F;
  231.     {$ENDC}
  232. FUNCTION DBInit(VAR sessID: LONGINT; ddevName: ConstStr63Param; host: ConstStr255Param; user: ConstStr255Param; passwd: ConstStr255Param; connStr: ConstStr255Param; asyncPB: DBAsyncParmBlkPtr): OSErr;
  233.     {$IFC NOT GENERATINGCFM}
  234.     INLINE $303C, $0E02, $A82F;
  235.     {$ENDC}
  236. FUNCTION DBEnd(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  237.     {$IFC NOT GENERATINGCFM}
  238.     INLINE $303C, $0403, $A82F;
  239.     {$ENDC}
  240. FUNCTION DBGetConnInfo(sessID: LONGINT; sessNum: INTEGER; VAR returnedID: LONGINT; VAR version: LONGINT; VAR ddevName: Str63; VAR host: Str255; VAR user: Str255; VAR network: Str255; VAR connStr: Str255; VAR start: LONGINT; VAR state: OSErr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  241.     {$IFC NOT GENERATINGCFM}
  242.     INLINE $303C, $1704, $A82F;
  243.     {$ENDC}
  244. FUNCTION DBGetSessionNum(sessID: LONGINT; VAR sessNum: INTEGER; asyncPB: DBAsyncParmBlkPtr): OSErr;
  245.     {$IFC NOT GENERATINGCFM}
  246.     INLINE $303C, $0605, $A82F;
  247.     {$ENDC}
  248. FUNCTION DBSend(sessID: LONGINT; text: Ptr; len: INTEGER; asyncPB: DBAsyncParmBlkPtr): OSErr;
  249.     {$IFC NOT GENERATINGCFM}
  250.     INLINE $303C, $0706, $A82F;
  251.     {$ENDC}
  252. FUNCTION DBSendItem(sessID: LONGINT; dataType: DBType; len: INTEGER; places: INTEGER; flags: INTEGER; buffer: UNIV Ptr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  253.     {$IFC NOT GENERATINGCFM}
  254.     INLINE $303C, $0B07, $A82F;
  255.     {$ENDC}
  256. FUNCTION DBExec(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  257.     {$IFC NOT GENERATINGCFM}
  258.     INLINE $303C, $0408, $A82F;
  259.     {$ENDC}
  260. FUNCTION DBState(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  261.     {$IFC NOT GENERATINGCFM}
  262.     INLINE $303C, $0409, $A82F;
  263.     {$ENDC}
  264. FUNCTION DBGetErr(sessID: LONGINT; VAR err1: LONGINT; VAR err2: LONGINT; VAR item1: Str255; VAR item2: Str255; VAR errorMsg: Str255; asyncPB: DBAsyncParmBlkPtr): OSErr;
  265.     {$IFC NOT GENERATINGCFM}
  266.     INLINE $303C, $0E0A, $A82F;
  267.     {$ENDC}
  268. FUNCTION DBBreak(sessID: LONGINT; abort: BOOLEAN; asyncPB: DBAsyncParmBlkPtr): OSErr;
  269.     {$IFC NOT GENERATINGCFM}
  270.     INLINE $303C, $050B, $A82F;
  271.     {$ENDC}
  272. FUNCTION DBGetItem(sessID: LONGINT; timeout: LONGINT; VAR dataType: DBType; VAR len: INTEGER; VAR places: INTEGER; VAR flags: INTEGER; buffer: UNIV Ptr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  273.     {$IFC NOT GENERATINGCFM}
  274.     INLINE $303C, $100C, $A82F;
  275.     {$ENDC}
  276. FUNCTION DBUnGetItem(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  277.     {$IFC NOT GENERATINGCFM}
  278.     INLINE $303C, $040D, $A82F;
  279.     {$ENDC}
  280. FUNCTION DBKill(asyncPB: DBAsyncParmBlkPtr): OSErr;
  281.     {$IFC NOT GENERATINGCFM}
  282.     INLINE $303C, $020E, $A82F;
  283.     {$ENDC}
  284. FUNCTION DBGetNewQuery(queryID: INTEGER; VAR query: QueryHandle): OSErr;
  285.     {$IFC NOT GENERATINGCFM}
  286.     INLINE $303C, $030F, $A82F;
  287.     {$ENDC}
  288. FUNCTION DBDisposeQuery(query: QueryHandle): OSErr;
  289.     {$IFC NOT GENERATINGCFM}
  290.     INLINE $303C, $0210, $A82F;
  291.     {$ENDC}
  292. FUNCTION DBStartQuery(VAR sessID: LONGINT; query: QueryHandle; statusProc: DBStatusUPP; asyncPB: DBAsyncParmBlkPtr): OSErr;
  293.     {$IFC NOT GENERATINGCFM}
  294.     INLINE $303C, $0811, $A82F;
  295.     {$ENDC}
  296. FUNCTION DBGetQueryResults(sessID: LONGINT; VAR results: ResultsRecord; timeout: LONGINT; statusProc: DBStatusUPP; asyncPB: DBAsyncParmBlkPtr): OSErr;
  297.     {$IFC NOT GENERATINGCFM}
  298.     INLINE $303C, $0A12, $A82F;
  299.     {$ENDC}
  300. FUNCTION DBResultsToText(VAR results: ResultsRecord; VAR theText: Handle): OSErr;
  301.     {$IFC NOT GENERATINGCFM}
  302.     INLINE $303C, $0413, $A82F;
  303.     {$ENDC}
  304. FUNCTION DBInstallResultHandler(dataType: DBType; theHandler: DBResultHandlerUPP; isSysHandler: BOOLEAN): OSErr;
  305.     {$IFC NOT GENERATINGCFM}
  306.     INLINE $303C, $0514, $A82F;
  307.     {$ENDC}
  308. FUNCTION DBRemoveResultHandler(dataType: DBType): OSErr;
  309.     {$IFC NOT GENERATINGCFM}
  310.     INLINE $303C, $0215, $A82F;
  311.     {$ENDC}
  312. FUNCTION DBGetResultHandler(dataType: DBType; VAR theHandler: DBResultHandlerUPP; getSysHandler: BOOLEAN): OSErr;
  313.     {$IFC NOT GENERATINGCFM}
  314.     INLINE $303C, $0516, $A82F;
  315.     {$ENDC}
  316.  
  317. {$ALIGN RESET}
  318. {$POP}
  319.  
  320. {$SETC UsingIncludes := DatabaseAccessIncludes}
  321.  
  322. {$ENDC} {__DATABASEACCESS__}
  323.  
  324. {$IFC NOT UsingIncludes}
  325.  END.
  326. {$ENDC}
  327.